Pay-Over-Time Transaction API

1.1.x
(0 reviews)

Technical Notes

Pay Over Time API Life Path
  • transactions.get or eligible-transactions.get
    • Param: accountNumber as string
    • Returns (transactions.get): all transactions for the past 31 days with "plan-id" attached. If the transaction is eligible for pay over time, the plan-id will be a numeric value otherwise it will be null
    • Returns (eligible-transactions.get): only pay over time eligible transactions for the past 31 days with "plan-id" attached. plan-id is a numeric value representing the plan that is available for the transaction to use
  • plan-details.get
    • Param: accountNumber as string
    • Param: transaction_id as string taken from the transactions.get or eligible-transactions.get call returned transaction dtl_indust_tran_id
    • Param: plan_id as number taken from the transactions.get or eligible-transactions.get call returned "plan-id"
    • Returns: eligible plan details for the transaction and provides an offer with payment terms to select from. Each payment term will have a "payment_terms_id" that is used to select an offer for conversion to pay over time loan (accepted offer)
  • accepted-offer
      - Note: transaction reversal and repost as loan take up to 24 hours (next daily cycle).
    • Param: accountNumber as string
    • Param: transaction_id as string taken from the transactions.get or eligible-transactions.get call returned transaction dtl_indust_tran_id
    • Param: plan_id as number taken from the transactions.get or eligible-transactions.get call returned "plan-id"
    • Param: payment_terms_id as a number taken from the plan-details.get and user selected "payment_terms_id"
Additional Pay Over Time API Endpoints
  • accepted-offer.get
    • Param: accountNumber as string
    • Param (optional): status as string sets the filter to the status of the loan (accepted offer); default is "A"
      • A - Active
      • C - Closed Charged Off
      • P - Closed Paid In Full
    • Param (optional): offer_id as number limits the returned offers to the one offer that matches the offer_id. The offer_id may be retrieved from the accepted-offer response or from a prior call to accepted-offer.get
    • Returns: list of loans (accepted offers) that match the input. The returned loans include the plan properties, payment term properties, and offer properties
  • disclosure.get
    • Param: accountNumber as string
    • Param (optional if disclosure_id is input): plan_id as number taken from the transactions.get or eligible-transactions.get call returned "plan-id"
    • Param (optional if plan_id is input): disclosure_id as number taken from the plan-details.get
  • faq.get
    • Param: accountNumber as string
    • Param (optional if faq_id is input): plan_id as number taken from the transactions.get or eligible-transactions.get call returned "plan-id"
    • Param (optional if plan_id is input): faq_id as number taken from the plan-details.get

Reviews